Note Feed Tool – Properties
The following table lists and describes properties of the Note Feed Tool as they are exposed on the Property Sheet and/or in the tool's script editor. Many of these properties are also exposed on a tool's (OCXProperties) property sheets. A property's name sometimes varies depending on where it appears.
Note: If a property or method in the script editor has two forms with the same name, one form exists for legacy support and the other form is current. When possible, use the current form. To select the current form, append .X. to the name of the object to which the property or method applies, and then enter the property or method name. For instance, enter MyObject.X.MyProperty. If a property or method in the script editor has only one form, the X method might or might not apply. The
column in the table below indicates whether or not a property or method is accessible using the X method.
| Property Sheet |
Script Editor |
|
Description |
|---|---|---|---|
|
Appearance |
No |
Appearance specifies whether the object boundary (graph, cell in the grid, view, etc.) will have a 3D effect or a flat appearance. Options are 0 — Flat or 1 — 3D. Default is 0 — Flat. Script subtype is integer. See also BorderStyle. |
|
|
N/A |
|||
|
BorderStyle |
No |
Specifies whether or not the object has a border. Options are 0 - None and 1 - Fixed Single. Default is 0 - None. Script subtype is integer. See also Appearance. |
|
|
Bottom |
No |
Bottom specifies the distance (in pixels) from the top of TheView’s scroll region to the bottom of the object. You can dynamically change this value in Edit mode if you use the mouse to enlarge or shrink the object. See Sizing and Positioning Objects. Script subtype is integer. |
|
|
CursorPointer |
No |
For TheView, CursorPointer selects the cursor icon that appears when you mouse over objects. For objects, CursorPointer selects the cursor icon for the instance of the object. The object’s cursor pointer takes precedence over TheView’s cursor pointer. The default is 0 — Default. For TheView, this is an arrow. For other objects, the icon configured for TheView is used. Other options are:
Script subtype is long. Script subtype is long. |
|
|
N/A |
|||
|
Enable |
No |
Currently disabled. Script subtype is long. See also Visible. |
|
|
N/A |
No |
FlexHorizontal specifies whether the object moves or resizes horizontally or is unchanged when TheFrame is resized. Options are:
Default is 0 — None. |
|
|
N/A |
No |
FlexVertical specifies whether the object moves or resizes vertically when TheFrame is resized. Options are:
Default is 0 — None. |
|
|
N/A |
|||
|
N/A |
|||
|
Group |
No |
Group groups objects into a discrete sequence that can be navigated using the arrow keys. Options are 0 — No and 1 — Yes. The default is 0 — No. To use this property: 1. Add objects that use the Group property to a screen. 2. Position them as you like (typically in a spatial configuration that reflects the order in which they were added to the screen). 3. Decide where in the spatial configuration logical groups begin and end. 4. Mark the beginning of a group by setting the Group property to 1 — Yes for the first object in the group. 5. Set Group set to 0 — No for other objects in the group. The group is made up of all objects that 1) are added sequentially after an object with a Group property set to 1 — Yes and 2) that use a Group property set to 0 — No. A group's arrow navigation sequence reflects the order in which its objects were added to a screen. This property is not related to the Draw > Group option in the CygNet Studio menu bar. This property might not be suited for use with all tools that include the Group property. Script subtype is long. See also Tabstop. |
|
|
N/A |
Specifies the GroupID of the object group. |
||
|
N/A |
Returns a Boolean value to confirm a CygNet-aware tool is associated with a valid CygNet tag. This property may not be suited for use with all tools that include the HasValidTag property. See also CygNet-Aware Tools. Script subtype is Boolean. |
||
|
HelpContextID |
No |
Specifies the object's Help topic identifier for context-sensitive Help. You must also enable the WhatsThisHelp property for TheFrame. Default is 0. Script subtype is long. |
|
|
N/A |
Returns a Boolean value that confirms that an object is a CygNet-aware tool. This property might not be suited for use with all tools that include the IsCygNetAware property. Script subtype is Boolean. See also CygNet-Aware Tools. |
||
|
LayerID |
No |
Specifies the layer name to which an object belongs. Options vary depending on the names of existing layers. Default is Default. Script subtype is long. See also Using Layers. |
|
|
Left |
No |
Specifies the distance in pixels from the left edge of TheFrame to the left edge of an object. Script subtype is long. |
|
|
Code |
No |
(ObjectCode) specifies a unique identifier of the object. You can enter up to 39 characters. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. The default is the object name and the numeric instance. Script subtype is string. |
|
|
N/A |
No |
Displays the OCXProperty dialog box unique to the object. |
|
|
Right |
No |
Specifies the distance in pixels from the right edge of TheFrame to the right edge of an object. Script subtype is long. |
|
|
N/A |
|||
|
TabStop |
No |
Tabstop specifies whether the focus stops on the object when you use the Tab key to navigate between objects (in other words, enables the object as a tab stop). Options are 0 — No and 1 — Yes. Default is 1 — Yes. Script subtype is long. Note: To set the tab order, use the Objects option on the Layout menu. |
|
|
Tag |
No |
Extra field provided for application-specific purposes. Does not require a CygNet point. Default is blank. Script subtype is variant. |
|
|
ToolTipText |
No |
Specifies the text displayed in the object's tooltip in Run mode. Tooltip text can be dynamic, static, or a combination of both. Dynamic text is built using tokens, which can represent a number of different values. Data formatting can also be specified. Default is blank. Script subtype is string. See also Using Text Tokens. |
|
|
N/A |
No |
Returns a CygNet-defined string value that describes the object type. This value appears in the Status Bar when you hover over a default control in its tool palette. You can also display the value using a script. This property is read only. See also Rule-Based Substitution. Script subtype is string. |
|
|
Top |
No |
Specifies the distance in pixels from the top edge of TheFrame to the top edge of an object. Script subtype is string. |
|
|
N/A |
No |
Specifies the Object Code of the Trend Tool object with which this Note Feed Tool is meant to synchronize. A Note Feed Tool may only display note records from a single Trend Tool. But a single Trend Tool may be associated with multiple Note Feed Tools. |
|
|
Visible |
No |
Specifies whether or not an object is displayed in Run mode. Options are 0 - No and 1 - Yes. Default is 1 - Yes. Script subtype is long. |


